<?php

/*

    MMetaverse - Open Metaverse Access Library

    Copyright (c) 2009 Mary Jane Soft - Marlon J. Manrique

    http://www.maryjanesoft.com
    http://www.marlonj.com

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General
    Public License along with this library; if not, write to the
    Free Software Foundation, Inc., 59 Temple Place, Suite 330,
    Boston, MA  02111-1307  USA

    $Id$

*/

/**
 * @package mjs.mmetaverse.manager
 */

/**
 * Region Information 
 */
class MRegion {
    /**
     * UUID
     * 
     * @var MUUID
     */
    private $uuid;

    /**
     * Region Name
     *
     * @var string
     */
    private $name;

    /**
     * Location in X
     *
     * @var integer
     */
    private $locationX;

    /**
     * Location in Y
     * 
     * @var integer
     */
    private $locationY;

    /**
     * Location in Z
     * 
     * @var integer
     */
    private $locationZ;

    /**
     * The region server ip 
     *
     * @var string
     */
    private $serverIP;

    /**
     * The region server port
     *
     * @var integer
     */
    private $serverPort;

    /**
     * Create a region with the info specified 
     *
     * @param MUUID $uuid
     * @param string $name
     * @param integer $locationX
     * @param integer $locationY
     * @param integer $serverIP
     * @param integer $serverPort
     */
    public function MRegion(MUUID $uuid, $name,
        $locationX, $locationY, $locationZ,
        $serverIP, $serverPort) {
        $this->uuid = $uuid;
        $this->name = $name;
        $this->locationX = $locationX;
        $this->locationY = $locationY;
        $this->locationZ = $locationZ;
        $this->serverIP = $serverIP;
        $this->serverPort = $serverPort;
    }

    /**
     * Return the identifier of the region
     * 
     * @return MUUID identifier of the region 
     */
    public function getUUID() {
        return $this->uuid;
    }

    /**
     * Return the name of the region
     *
     * @return string name of the region
     */
    public function getName() {
        return $this->name;
    }

    /**
     * Return the location in x of the region 
     *
     * @return integer location x of the region
     */
    public function getLocationX() {
        return $this->locationX;
    }

    /**
     * Return the location in y of the region
     *
     * @return integer location y of the region
     */
    public function getLocationY() {
        return $this->locationY;
    }

    /**
     * Return the location in z of the region
     *
     * @return integer location z of the region
     */
    public function getLocationZ() {
        return $this->locationZ;
    }

    /**
     * Return the ip of the region server
     *
     * @return string the ip of the region server
     */
    public function getServerIP() {
        return $this->serverIP;
    }

    /**
     * Return the port in the region server
     *
     * @return integer the port in the region server
     */
    public function getServerPort() {
        return $this->serverPort;
    }
}

?>
